Resource {id}

Keycloak REST Services 1.5.0-Final

Path: / admin / realms / {realm} / clients / {id}

Get representation of the client.

Path parameters:

realm - realm name (not id!)

id - id of client (not client-id)

Sub-Resources

Resources
Name	Description
allowed-origins	Returns set of allowed origin.
certificates ↳ certificates/{attr}
client-secret	Get the secret of this client
installation
logout-all	If the client has an admin URL, invalidate all sessions associated with that client directly.
logout-user ↳ logout-user/{username}	If the client has an admin URL, invalidate the sessions for a particular user directly.
nodes	Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle by sending registration request to Keycloak
protocol-mappers
push-revocation	If the client has an admin URL, push the client's revocation policy to it.
roles	List all roles for this realm or client
scope-mappings	Get all scope mappings for this client
service-account-user	Returns user dedicated to this service account
session-count	Number of user sessions associated with this client { "count": number }
test-nodes-available	Test if registered cluster nodes are available by sending 'ping' request to all of them
user-sessions	Return a list of user sessions associated with this client

Resource Methods

Method Summary
Name	Description
`PUT /admin/realms/{realm}/clients/{id}`	Update the client.
`GET /admin/realms/{realm}/clients/{id}`	Get representation of the client.
`DELETE /admin/realms/{realm}/clients/{id}`	Delete this client.

Update the client.

HTTP Example:: PUT /admin/realms/{realm}/clients/{id}
API Example:: ClientResource.update({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */, '$entity': /* rep */});
Input:: ClientRepresentation
Output:: Response -
Consumes:: application/json

Get representation of the client.

HTTP Example:: GET /admin/realms/{realm}/clients/{id}
API Example:: ClientResource.getClient({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */});
Output:: ClientRepresentation -
Produces:: application/json

Delete this client.

HTTP Example:: DELETE /admin/realms/{realm}/clients/{id}
API Example:: ClientResource.deleteClient({'realm': /* name realm name (not id!) */, 'id': /* id id of client (not client-id) */});
Output:: void

Keycloak REST Services 1.5.0-Final